/*
 * IGAdminCommand.java
 * Created on 29 sept. 2008
 *
 * Glacéo Internet Platform
 * http://sourceforge.net/projects/chm/
 *
 * Copyright (c) 2005-2008, Jens and Jan Janke (VirtualHockey Project)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hockeo.vhadmin;

import com.hockeo.vhbase.error.GException;

/**
 * Represents a command that is usable on the shell of the Glacéo administration console.
 *
 * @version $Id$
 * @author jjanke
 */
public interface IGAdminCommand
{
  /**
   * Returns the command short cut (used to call the command).
   */
  public String getShortCut();

  /**
   * Returns the name of the command.
   */
  public String getName();

  /**
   * Returns the command's short description.
   */
  public String getShortDesc();

  /**
   * Executes the command.
   *
   * @param strArgs all the arguments that have been passed to the command
   */
  public void execute( String[] strArgs ) throws GException;

  /**
   * Prints out a usage help indicating how to use the command.
   */
  public void showUsageHelp();
}
